Skip to content

Conversation

@tina-cloud-app
Copy link
Contributor

@tina-cloud-app tina-cloud-app bot commented Jan 8, 2026

This pull request updates the metadata and content of the do-you-document-your-webapi rule to improve consistency, SEO, and clarity. The most important changes include restructuring the frontmatter for better formatting, updating the documentation recommendation to include Scalar, and refining metadata fields.

Metadata and formatting improvements:

  • Restructured the frontmatter by reordering and formatting fields, using consistent date formats, and grouping related metadata for clarity and maintainability.
  • Updated the seoDescription field to use a multi-line format for improved readability and SEO.
  • Changed date formats in created and lastUpdated fields to ISO 8601 for consistency.

Content updates:

  • Revised the documentation recommendation to include Scalar alongside Swagger and Swashbuckle, reflecting current best practices for Web API documentation.

Co-authored-by: Anton Polkanov <[email protected]>
@github-actions github-actions bot added the Age: 🥚 - New About 2 hours old label Jan 8, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 8, 2026

PR Metrics

Thanks for keeping your pull request small.

Lines
Product Code -
Test Code -
Subtotal -
Ignored Code 17
Total 17

Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs!

@github-actions github-actions bot changed the title public/uploads/rules/do you-document-your-webapi/rule (PR from TinaCMS) XS ◾ public/uploads/rules/do you-document-your-webapi/rule (PR from TinaCMS) Jan 8, 2026
@AntPolkanov AntPolkanov changed the title XS ◾ public/uploads/rules/do you-document-your-webapi/rule (PR from TinaCMS) XS ◾ Mention Scalar as an API documentation tool Jan 9, 2026
@AntPolkanov AntPolkanov marked this pull request as ready for review January 9, 2026 00:04
@github-actions github-actions bot added Age: 🐣 - Young About 4 hours old Age: 🐥 - Adolescent About 8 hours old Age: 🐤 - Mature About 16 hours old Age: 🐓 - Old About 32 hours old Age: 🍗 - Ancient About 64 hours old Age: 🦖 - Extinct About 128 hours old and removed Age: 🥚 - New About 2 hours old Age: 🐣 - Young About 4 hours old Age: 🐥 - Adolescent About 8 hours old Age: 🐤 - Mature About 16 hours old Age: 🐓 - Old About 32 hours old Age: 🍗 - Ancient About 64 hours old labels Jan 9, 2026
@tiagov8 tiagov8 merged commit ee89fa2 into main Jan 12, 2026
8 checks passed
@tiagov8 tiagov8 deleted the tina/public/uploads/rules/do-you-document-your-webapi/rule branch January 12, 2026 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Age: 🦖 - Extinct About 128 hours old

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants